Class TCellArea

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TCellArea = class(TObject)

Description

Represents a cell area.

Hierarchy

  • TObject
  • TCellArea

Overview

Methods

Public procedure Normalize;
Public procedure Assign(Source: TCellArea);
Public procedure SetSize(const C,R: integer); overload;
Public procedure SetSize(const C1,R1,C2,R2: integer); overload;
Public function InArea(const C1,R1,C2,R2: integer): boolean;
Public function CornerInArea(const C1,R1,C2,R2: integer): boolean; overload;
Public function CornerInArea(AArea: TCellArea): boolean; overload;
Public function CellCount: integer;
Public function CellInArea(const Col,Row: integer): boolean;
Public function Equal(const C1,R1,C2,R2: integer): boolean;

Properties

Public property AsRecArea: TXLSCellArea read GetAsRecArea write SetAsRecArea;
Public property Edges[constCol,Row:integer]: TCellEdges read GetEdges;
Public property Col1: integer read GetCol1 write SetCol1;
Public property Row1: integer read GetRow1 write SetRow1;
Public property Col2: integer read GetCol2 write SetCol2;
Public property Row2: integer read GetRow2 write SetRow2;
Public property AsString: AxUCString read GetAsString;
Public property Id: integer read FId;
Public property Obj: TObject read FObject write FObject;

Description

Methods

Public procedure Normalize;

Normalizes the area; Checks so that Col1 <= Col2 and Row1 <= Row2.

Public procedure Assign(Source: TCellArea);

Assignes another TCellArea to this area. ˜param Source The source TCellArea.

Public procedure SetSize(const C,R: integer); overload;

Sets the size of the area. Same as setting the ˜[link Col1], ˜[link Row1], ˜[link Col2] and ˜[link Row2] properties. ˜param C1 Left column. ˜param R1 Top row. ˜param C2 Right column. ˜param R2 Bottom row.

Public procedure SetSize(const C1,R1,C2,R2: integer); overload;
 
Public function InArea(const C1,R1,C2,R2: integer): boolean;

True if the area is fully inside C1,R1,C2,R2.

Public function CornerInArea(const C1,R1,C2,R2: integer): boolean; overload;

True if any of the area corners is inside C1,R1,C2,R2.

Public function CornerInArea(AArea: TCellArea): boolean; overload;
 
Public function CellCount: integer;
 
Public function CellInArea(const Col,Row: integer): boolean;

Check if a position is in the area. ˜param Col Column of the porition. ˜param Row Row of the porition. ˜result True if the cell is in the area.

Public function Equal(const C1,R1,C2,R2: integer): boolean;

Tests if an area is equal to the coordinates of this area. ˜param C1 Left column of the test area. ˜param R1 Top row of the test area. ˜param C2 Right column of the test area. ˜param R2 Bottom row of the test area. ˜result True is the areas are equal.

Properties

Public property AsRecArea: TXLSCellArea read GetAsRecArea write SetAsRecArea;

Returns the coordinates of the area as an TRecCellArea object.

Public property Edges[constCol,Row:integer]: TCellEdges read GetEdges;

Returns the edges in the area that the position given by Col and Row borders to. Col and Row must be inside the area.

Public property Col1: integer read GetCol1 write SetCol1;

First column in the area.

Public property Row1: integer read GetRow1 write SetRow1;

First row in the area.

Public property Col2: integer read GetCol2 write SetCol2;

Last column in the area.

Public property Row2: integer read GetRow2 write SetRow2;

Last row in the area.

Public property AsString: AxUCString read GetAsString;
 
Public property Id: integer read FId;
 
Public property Obj: TObject read FObject write FObject;
 

Generated by PasDoc 0.12.1 on 2013-03-18 12:36:47